home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d13 / rir12.arc / RIR.DOC < prev    next >
Encoding:
Text File  |  1991-01-07  |  11.0 KB  |  271 lines
  1. RIR - Rock dIRectory 1.2
  2.  
  3.  
  4. Purpose
  5.  
  6.     Rock Directory (RIR) is a substitute command for DOS's
  7.     directory (DIR) with several additions.  The syntax and
  8.     output of RIR is virtually identical to that of DOS's "DIR"
  9.     command, making it easy to learn.
  10.  
  11.  
  12. Uses
  13.  
  14.     RIR accepts the /W and /P parameters just as DOS's DIR
  15.     command does.  RIR is of great use to those who have a large
  16.     number of compressed files.  Its automatic detection of
  17.     compressed files makes it easier to use than most methods of
  18.     viewing the contents of compressed files; it displays them
  19.     along with a directory's other files.  It also shows
  20.     additional information as listed below.
  21.  
  22.     The features RIR provides that DIR does not are:
  23.  
  24.         A single key can be used to pause/restart the display,
  25.         and ESC can be used to halt the display, as with many of
  26.         the other Rock utilities.
  27.  
  28.         RIR displays the contents of compressed files, such as
  29.         ".ARC" and ".ZIP" files.
  30.  
  31.         RIR can display directory listings with two files per
  32.         line if desired (use the /2 option).
  33.  
  34.         RIR allows you to display files in lower case (/AL
  35.         option), display hidden files (/H option), show times in
  36.         24-hour format (/24 option), and display file attributes
  37.         (/FA option) if you prefer those features in directory
  38.         listings.
  39.  
  40.         RIR will display file descriptions created with Norton's
  41.         FI or 4-DOS's DESCRIBE programs.
  42.  
  43.         RIR will also list the size & palette range of ".GIF" and
  44.         ".PCX" image files.  It can optionally list the memory
  45.         required to run .EXE files (/EC option).
  46.  
  47.         Default parameters can be set through the /RIRCMD
  48.         environment variable (see below for an explanation).
  49.  
  50. Compressed Files
  51.  
  52.     The compressed file formats that RIR can decipher are:
  53.  
  54.         .ARC, .DWC, .LBR, .LZH, .LZS, .MD, .PKA, .PAK, .ZIP, .ZOO
  55.  
  56.     Note that RIR does not decode self-extracting compressed
  57.     files, which end in .COM or .EXE.
  58.  
  59.  
  60. What are compressed files?
  61.  
  62.     Not everyone uses, or needs to use, compressed files.  This
  63.     section is for those who are confused by what the term
  64.     "compressed file" means.
  65.  
  66.     A compressed file is a single file created to store one or
  67.     more other files in a "compressed" format to save space.  A
  68.     special compression/decompression program is required to do
  69.     this, such as "ARC" or "PKZIP," both available from most
  70.     shareware distribution sources or bulletin board systems.
  71.  
  72.     Compression is used for several reasons; to save space with
  73.     old files that are rarely used, to fit a lot of data on
  74.     floppy disks, or to send file through telephone lines more
  75.     quickly.  You might squeeze five 100K text files into a
  76.     single 200K compressed file, store it on a floppy, and when
  77.     you need it again, decompress it into the original five
  78.     files.  Those who download files with modems usually receive
  79.     the files in a compressed form - it's faster to download
  80.     smaller files, and with some systems, time is money!
  81.  
  82.     It's often convenient to view the contents of compressed
  83.     files without actually decompressing them.  Most
  84.     decompression programs can show the contents of files
  85.     compressed in their own format, but each compression program
  86.     has its own file format.  RIR shows you the contents of many
  87.     formats of compressed files.
  88.  
  89. Syntax
  90.  
  91.     RIR [d:][path][filespec] [options]
  92.  
  93.     Options
  94.        /?      Show the syntax and standard options
  95.        /P      Pause every screenful (just like with DIR)
  96.        /W      Display in Wide format (5 files per line)
  97.        /2      Display two files per line instead of one
  98.        /T      Text lines only, e.g. <-- instead of ──
  99.        /H      Show "hidden" files also
  100.        /XTRA   Show even more options, for power users!
  101.        /INFO   Show information about the Rock utilities
  102.  
  103.  
  104.     Examples
  105.        rir             Show current dir, with compressed files
  106.        rir /p          Show current dir, pausing every screen
  107.        rir c:\new\*.*  Show files in the directory c:\new
  108.        rir /w          Show current directory, 5 files per line
  109.        rir a: /2       Show directory of A:, 2 files per line
  110.  
  111.  
  112.     Control Keys
  113.        ESC     Stop the program immediately
  114.        Others  Pause the program until next key pressed
  115.  
  116.  
  117.     The following options are given when you run RIR with the
  118.     /XTRA option.  They're for those who really want to tailor the
  119.     appearance of directory listings.
  120.  
  121.     /24   Show times in 24-hour mode instead of 12-hour mode
  122.     /AU   All Upper case names for files/directories
  123.     /AL   All Lower case names for files/directories
  124.     /ALF  All Lower case names for Files (but not directories)
  125.     /NC   No Comments (right half of display in normal listing)
  126.     /N4D  No 4-Dos comments (ignore 4-DOS file descriptions)
  127.     /NFI  No FI comments (ignore Norton FI file descriptions)
  128.     /NCF  No Compressed File comments (# & size of contents)
  129.     /NV   No Volume label displayed at top of directory
  130.     /NH   No header at top at all (no program name, volume)
  131.     /EC   EXE comments - show memory required to run EXE files
  132.     /JFS  Just Free Space (just give bytes free at end)
  133.     /FA   Show file attributes of all files/directories
  134.  
  135. Environment Variables
  136.  
  137.     An environment variable is a piece of information you record
  138.     from the DOS command line to be used by various programs.
  139.     Each environment variable consists of a one-word name and an
  140.     associated value for the variable, generally a set of words
  141.     or symbols.  If you type "SET" from the DOS command line,
  142.     you'll see your current environment variables.  Common ones
  143.     include "prompt" and "path", usually set in an autoexec.bat
  144.     file.  Most DOS handbooks contain a more in-depth discussion
  145.     of environment variables and their typical uses.
  146.  
  147.     To set an environment variable, you type something like "SET
  148.     NAME WHATEVER VALUE", creating a variable called "NAME" with
  149.     the associated value "WHATEVER VALUE", which resides in DOS
  150.     memory until you turn your machine off.  If you type "SET"
  151.     now, DOS will list "NAME" along with any previously set
  152.     environment variables.
  153.  
  154.     How does RIR use environment variables? If you use certain
  155.     options almost always, you can save typing by setting a
  156.     variable called "RIRCMD" with the options you typically use
  157.     with RIR.  Every time you run RIR, it will first check the
  158.     RIRCMD variable to see if you set any options that you want
  159.     used every time you run RIR.
  160.  
  161.     For example, type "SET RIRCMD /P /24" from the DOS command
  162.     line to have RIR use the /P and /24 options until you turn
  163.     the system off, or add it to your autoexec.bat to set the
  164.     parameters each time you boot your system, so RIR will always
  165.     use the /P and /24 options.
  166.  
  167.  
  168. Customizing output
  169.  
  170.     If you have several sets of default options that you like to
  171.     use with RIR, here are two suggestions.  One is to have
  172.     separate batch files that run RIR with a particular set of
  173.     command-line options, for example "WDIR.BAT" might contain
  174.     the line "RIR %1 /W /P /AL".  Another approach is to have
  175.     batch files that set the RIRCMD environment variable, for
  176.     example "WDIR.BAT" could similarly contain the line "SET
  177.     RIRCMD /W /P /AL", so that after you run wdir once, you can
  178.     just run RIR, and it will use those parameters.
  179.  
  180. File Attributes
  181.  
  182.     If you use the /FA parameter, each file will be followed by a
  183.     pair of bracket with attribute codes between them, such as
  184.     "[RHSVDA]".
  185.  
  186.     In practice, only some of the letters will appear between any
  187.     particular pair of brackets, as some letters are mutually
  188.     exclusive.  The letters stand for the following file
  189.     attributes:
  190.  
  191.            R - Read only   H - Hidden      S - System
  192.            V - Volume      D - Directory   A - Archive
  193.  
  194.     As an example of mutually exclusive file attributes, a Volume
  195.     cannot be a Directory, so V and D will never appear within
  196.     the same pair of brackets.
  197.  
  198.  
  199. Next Version
  200.  
  201.     Two extensions are planned for the next version of RIR.  One
  202.     is a recursive directory search, meaning you can use RIR to
  203.     list a directory along with all of its subdirectories, and
  204.     the other is directory sorting, so that you can display files
  205.     sorted by name, extension, size, or date.  If the version
  206.     with these capabilities isn't finished by the time you
  207.     register your copy of the Rock Utilities, we'll send you a
  208.     free update disk with the newer version of RIR when it
  209.     becomes available. Type "RIR /INFO" for information on the
  210.     Rock Utils, or "RIR /ORDER" for an order form.
  211.  
  212.  
  213. Credits
  214.    
  215.     RIR's ompressed file directory routines came from several
  216.     sources, including Phil Burn's PIBCAT, public domain disk
  217.     cataloging system, and Don Williams' Fast File Find program.
  218.  
  219. Example - show current directory
  220.  
  221.     The arrows following the extensions in the following examples
  222.     indicate that the file is contained within the compressed
  223.     file preceding it.  In the example below, the file
  224.     "TTOOLS.ZIP" contains the files "TTOOLS.TPU", "TTOOLS.PAS",
  225.     and "READ.ME".  Note that the default directory listing is
  226.     easier to read than the listings with two or five-files per
  227.     line. Also in the first example, two user-created file
  228.     descriptions are listed; creating them requires other
  229.     programs.  The other three comments, to the right of the
  230.     files, were created by RIR based on information in the file,
  231.     for example the size and palette of the "GIF" (Graphic
  232.     Interchange Format) image file.
  233.  
  234.     C:\DATA>rir
  235.  
  236.     RIR-Rock dIRectory 1.2, (C) 1991 Rock     "RIR ?" for options
  237.  
  238.      Volume in drive C is Devel
  239.      Volume Serial Number is 1515-15E1
  240.      Directory of  C:*.*
  241.  
  242.     .           <DIR>     01-07-91  1:36a
  243.     ..          <DIR>     01-07-91  1:36a
  244.     M        GIF   191529 12-15-90 10:33a 800x600 256 colors
  245.     BINOBJ   EXE    11088 08-29-88  5:00a This comment made w/FI
  246.     PRINT    TP5     2917 07-21-89 11:27a This one made w/4-DOS
  247.     FILEINFO FI       522 12-28-90  1:47a Contains 1 file comment
  248.     TPC      EXE    61926 05-02-89  5:50a
  249.     TPUMOVER EXE    32784 08-29-88  5:00a
  250.     TURBO    EXE   156321 05-02-89  5:50a
  251.     TURBO    TPL    44352 05-02-89  5:50a
  252.     TTOOLS   ZIP╕  26752 11-01-90  8:45p 3 files in 42974 bytes
  253.     ttools   tpu─┤  34426 12-31-86  6:46p
  254.     ttools   pas─┤   7309 12-31-86  6:42p
  255.     read     me ─┘   1239 12-30-86  9:31p
  256.           11 File(s)     528191 bytes
  257.                         6100992 bytes free
  258.  
  259.  
  260. Example - show in wide mode, no header (normally 5 files/line)
  261.  
  262.     C:\DATA>rir /w /nh
  263.  
  264.     .              ..             M       GIF    TEMP     BAK
  265.     BINOBJ   EXE   FILEINFO FI    PRINT   TP5    TPC      EXE
  266.     TPUMOVER EXE   TURBO    EXE   TURBO   TPL    TTOOLS   ZIP═══
  267.     ttools   tpu──ttools   pas──read    me
  268.           11 File(s)     528191 bytes
  269.                         6100992 bytes free
  270.  
  271.